Retrieve Tool Manifest

get/tool/{toolName}/manifest

Retrieves the manifest for a specified tool.

Request
path Parameters
toolName
required
string

Name of the tool.

Responses
200

Manifest successfully retrieved.

Response Schema: application/json
displayDescription
required
string

Description of the tool meant for a human.

displayName
required
string (displayName)

Human understandable name of the tool. Max 50 characters.

name
required
string

Unique identifier for the tool. Name should be understandable by the LLM, and will be used to invoke a tool.

type
required
string

The type of tool.

Enum: "RETRIEVAL" "ACTION"
actionType
string

Valid only for ACTION tools. Represents the type of action tool REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.

Enum: "REDIRECT" "EXECUTION"
object (AuthConfig)

Config for tool's authentication method.

createdAt
string <date-time>

The time the tool was created in ISO format (ISO 8601)

object (PersonObject)
description
string

Description tailored to an LLM describing how to use the tool. 8,000 character max.

enablePreview
boolean
Default: true

Valid only for ACTION tools. If true, enable default preview and confirmation flow If false, directly execute the action.

exampleQueries
Array of strings

Example queries that can be used to invoke the tool.

knowledgeType
string

Indicates the kind of knowledge a tool would access or modify.

Enum: "NEUTRAL_KNOWLEDGE" "COMPANY_KNOWLEDGE" "WORLD_KNOWLEDGE"
lastUpdatedAt
string <date-time>

The time the tool was last updated in ISO format (ISO 8601)

object (PersonObject)
logoUrl
string (logoUrl)

URL used to fetch the logo.

objectName
string (objectName)

Name of the generated object. This will be used to indicate to the end user what the generated object contains.

object (ObjectPermissions)
toolId
string

An opaque id which is unique identifier for the tool.

writeActionType
string

Valid only for write actions. Represents the type of write action. REDIRECT - The client renders the URL which contains information for carrying out the action. EXECUTION - Send a request to an external server and execute the action.

Enum: "REDIRECT" "EXECUTION"
400

Bad Request

401

Not Authorized

404

Not Found

Request samples 
Response samples 
application/json
{
  • "type": "RETRIEVAL",
  • "name": "string",
  • "displayName": "string",
  • "toolId": "string",
  • "displayDescription": "string",
  • "logoUrl": "string",
  • "objectName": [
    • "HR ticket",
    • "Email",
    • "Chat message"
    ],
  • "knowledgeType": "NEUTRAL_KNOWLEDGE",
  • "createdBy": {
    • "name": "string",
    • "obfuscatedId": "string"
    },
  • "lastUpdatedBy": {
    • "name": "string",
    • "obfuscatedId": "string"
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "lastUpdatedAt": "2019-08-24T14:15:22Z",
  • "writeActionType": "REDIRECT",
  • "auth": {
    • "isOnPrem": true,
    • "usesCentralAuth": true,
    • "type": "NONE",
    • "grantType": "AUTH_CODE",
    • "status": "AWAITING_AUTH",
    • "client_url": "string",
    • "scopes": [
      • "string"
      ],
    • "audiences": [
      • "string"
      ],
    • "authorization_url": "string",
    • "lastAuthorizedAt": "2019-08-24T14:15:22Z"
    },
  • "permissions": {
    • "write": {
      • "scopeType": "GLOBAL",
      • "create": true,
      • "update": true,
      • "delete": true
      }
    },
  • "description": "string",
  • "enablePreview": true,
  • "actionType": "REDIRECT",
  • "exampleQueries": [
    • "string"
    ]
}